Skip to main content
POST
/
nous
/
signals
Create Signal
curl --request POST \
  --url https://api.sophra.org/api/nous/signals \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "SEARCH",
  "source": "web",
  "value": {
    "sessionId": "sess_123abc",
    "queryId": "q_789xyz",
    "resultId": "res_456def",
    "position": 3,
    "metadata": {
      "documentType": "product",
      "timeToClick": 2.5,
      "deviceType": "mobile",
      "viewport": {
        "width": 375,
        "height": 812
      }
    }
  },
  "strength": 0.8,
  "priority": 1,
  "metadata": {
    "status": "PENDING",
    "attempts": 0
  }
}
'
{
  "success": true,
  "data": {
    "signalId": "<string>",
    "status": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

Body

application/json
​
type
enum<string>
required

Type of signal

Available options:
SEARCH,
CLICK,
FEEDBACK,
SYSTEM
​
source
enum<string>
required

Source of the signal

Available options:
web,
api,
mobile,
system
​
value
object
required
​
strength
number

Signal strength or confidence

Required range: 0 <= x <= 1
​
priority
integer

Processing priority

Required range: 1 <= x <= 10
​
metadata
object

Response

201 - application/json

Signal created successfully

​
success
boolean
​
data
object